TUIアプリケーションフレームワーク asciimatics を使ってみよう

asciimatics について

https://gyazo.com/04a172eae76684d06741f62853b86156

次のような機能を提供しています。

色とスタイルを適用したテキストを出力

カーソル位置の制御

キーボード入力（ブロックまたはエコーなし）

マウス入力

コンソールのサイズ変更時の検出と処理

スクリーンスクレイピング

アンチエイリアスASCII線画

画像(JPEGおよびGIF形式)からASCIIへの変換

多くのアニメーション効果

スプライト、パーティクルシステム、バナーなど。

TUI用のさまざまなウィジェット

ボタン、テキストボックス、ラジオボタン、DatePicker(日付指定)、TimePicker(時間指定)など。

インストール

asciimatics は拡張モジュールなのでインストールが必要です。

code: zsh

% pip install asciimatics

Screenクラス

これにより、実行に必要なすべての初期化が処理され、作成された画面が指定された関数に渡されます。

code: asciimatics_screen.py

from asciimatics.screen import Screen

from time import sleep

def demo(screen):

screen.print_at('Hello world!', 0, 0)

screen.refresh()

sleep(10)

Screen.wrapper(demo)

code: asciimatics_managedscreen.py

from asciimatics.screen import Screen

from asciimatics.screen import ManagedScreen

from time import sleep

@ManagedScreen

def demo(screen=None):

screen.print_at('Hello world!', 0, 0)

screen.refresh()

sleep(10)

demo()

code: asciimatics_managedscreen_contextmanager.py

from asciimatics.screen import Screen

from asciimatics.screen import ManagedScreen

from time import sleep

def demo():

with ManagedScreen() as screen:

screen.print_at('Hello world!', 0, 0)

screen.refresh()

sleep(10)

demo()

出力

色

ターミナルには長い歴史があり、これは色に関しては明らかです。 古くはの端末の色は限られていたため、太字、下線、反転ビデオなどの効果を属性を使用して変更しました。 昨今では、より多くの色が追加され、いくつかの端末ではフル24ビットカラー(True Color)を設定することができます。

code: python

COLOUR_BLACK = 0

COLOUR_RED = 1

COLOUR_GREEN = 2

COLOUR_YELLOW = 3

COLOUR_BLUE = 4

COLOUR_MAGENTA = 5

COLOUR_CYAN = 6

COLOUR_WHITE = 7

これらは、背景色と前景色に適用することができます。多くのシステムでは、属性を使用して、前景色の数を2倍にすることもできます。

属性

属性は、初期のハードウェア端末が色を付ける前にサポートしていたいくつかの基本的な方法で、表示されるテキストを変更する方法です。 ほとんどのシステムはハードウェア端末を使用しなくなりましたが、この概念はすべてのネイティブコンソールAPIで維持されるため、ここでも使用されます。

code: python

A_BOLD = 1

A_NORMAL = 2

A_REVERSE = 3

A_UNDERLINE = 4

code: python

screen.print_at('Hello world!', 0, 0, COLOUR_GREEN, A_BOLD)

マルチカラー

Unicode

code: asciimatics_unicode.py

from asciimatics.constants import COLOUR_GREEN, A_BOLD

from asciimatics.screen import ManagedScreen

from time import sleep

def demo():

with ManagedScreen() as screen:

screen.print_at('☎ 電話番号:', 0, 0, COLOUR_GREEN, A_BOLD)

screen.refresh()

sleep(10)

demo()

画面のリフレッシュ

入力

KeyboardEvent

V1.7以降、ASCII文字セット以外のUnicode文字のキーボードイベントを取得することもできます。これらは、以前のASCII文字のサポートと同様に、Unicode文字の序数表現も返します。

代わりにランダムなゴミが表示されている場合は、システムがUnicode用に正しく構成されていない可能性があります。これを修正する方法については、Unicode文字が機能しないを参照してください。

MouseEvent

画面のリサイズ

プログラムで画面サイズを変更することはできません。ただし、ユーザーは、プログラムの実行中に端末またはコンソールのサイズを変更できます。 Asciimaticsは、元のサイズ内で可能な限り最高の状態で動作し続けるか、必要に応じて画面を新しいサイズに再作成するように指示できます。

スクリーンスクレイピング

code: python

current_char, fg, attr, bg = screen.get_from(x, y)

if current_char != 32:

screen.print_at('X', x, y)

シェイプ

code: python

# 画面の左上から対角線を引きます

screen.move(0, 0)

screen.draw(10, 10)

# 対角線をクリア

screen.move(0, 0)

screen.draw(10, 10, char=' ')

code: python

# 中央に小さな長方形の穴がある大きな穴を描きます

この描画方法はUnicodeブロック文字に対応しており、デフォルトで端末に適した文字セットになります。可能な場合はUnicodeブロック文字を使用し、そうでない場合は純粋なASCIIテキストにフォールバックします。

レンダリング

StaticRenderer

code: python

# Pre-render ASCIIMATICS using the big Figlet font

renderer = FigletText("ASCIIMATICS", font='big')

DynamicRenderer

code: python

# Render a bar chart with random bars formed of equals signs.

def fn():

return randint(0, 40)

これを画面で直接行うのではなく、エフェクトを使用してこれを処理するようにします。

詳細については、アニメーションを参照してください。

asciimaticsによって提供される多くの組み込みレンダラーがあります。 次のセクションでは、エリアごとにそれぞれを簡単に説明します。 レンダラーのその他の例については、asciimaticsサンプルフォルダーを参照してください。

画像をASCIIテキスト

Asciimaticsは、JPEG、GIFなど画像ファイルを同等のテキストに変換することができます。

これには、2つの方法が提供されています。

すべての画面のパレットを使用します。

どちらもアニメーションGIFをサポートしており、描画されると各画像をループして表示します。

アニメーションオブジェクト

Asciimaticsは、より複雑なアニメーション効果のために次のレンダラーを提供しています。

基本的に動的である可能性があります

テキストと色の操作

次のレンダラーは、いくつかの簡単なテキストと色の操作を提供しています。

ボックス

次のレンダラーは、いくつかの単純なボックスとボックス化されたテキストを提供します。

静的な色付けテキスト

code: pyton

StaticRenderer(images=[r"""

${3,1}*

/ \

/${1}o${2} \

/_ _\

/ \${4}b

/ \

/ ${1}o${2} \

/__ __\

${1}d${2} / ${4}o${2} \

/ \

/ ${4}o ${1}o${2}.\

/___________\

${3}|||

${3}|||

"""])

ユーザインタフェース

テキストUIの基本的な構成要素はウィジェットです。 asciimaticsが提供する標準的なもののセットがありますが、必要に応じてカスタムセットを作成できます。基本セットには、単純なWeb入力フォームとの類似点があります。ボタン、チェックボックスなど。

ウィジェットは画面上に配置し、サイズを変更するたびに再配置する必要があります。 Layoutクラスがこれを処理します。ウィジェットを1つに追加するだけです。

レイアウトを表示する必要があります。これを行うには、それらをフレームに追加する必要があります。このクラスはエフェクトであるため、他のエフェクトと一緒に任意のシーンで使用できます。フレームは、フレームに含まれるレイアウトの境界内に表示される部分を描画します。最終的な結果として、GUIフレームワークのウィンドウのように見え始めます。

https://gyazo.com/04a172eae76684d06741f62853b86156

フレームでは次のキー操作が行えます。

table: キー操作

キー操作 アクション

Tab フレーム内の次のウィジェットに移動

Backtab (shift+tab) フレーム内の前のウィジェットに移動

上カーソル 同じ列の現在のフォーカスの上にあるウィジェットに移動

下カーソル 同じ列の現在のフォーカスの下にあるウィジェットに移動

左カーソル 現在の入力フォーカスがある列の左側にある列の最後のウィジェットに移動

右カーソル 現在の入力フォーカスがある列の右側にある列の最初のウィジェットに移動

スペース/リターン 現在のウィジェットを選択

カーソルキーはレイアウト間を移動しないことに注意してください。 さらに、無効になっているウィジェットに移動することはできません。

テキスト編集ウィジェット内では、カーソルキーのアクションが上書きされ、代わりに、編集可能なテキスト（またはリスト）を期待どおりにナビゲートできるようになります。 さらに、次のキー操作を使用することもできます。

table: ウィジェット内でのキー操作

キー操作 アクション

Home/End 現在の行の開始/終了に移動

Delete カーソルの下の文字を削除

Backspace カーソルの前の文字を削除

Model/Viewの設計

これらのクラスが何か、そして何をするためのものかを説明する前に、これらを最大限に活用するためにどのように組み合わせる必要があるかを理解することが重要です。

ContactModelクラス

code: asciimatics_contactmodels.py

class ContactModel(object):

def __init__(self):

# メモリ上にデータベースを作成

self._db = sqlite3.connect(':memory:')

self._db.row_factory = sqlite3.Row

# contactsテーブルを作成

self._db.cursor().execute('''

CREATE TABLE contacts(

id INTEGER PRIMARY KEY,

name TEXT,

phone TEXT,

address TEXT,

email TEXT,

notes TEXT)

''')

self._db.commit()

# 編集時のコンタクトID

self.current_id = None

def add(self, contact):

self._db.cursor().execute('''

INSERT INTO contacts(name, phone, address, email, notes)

VALUES(:name, :phone, :address, :email, :notes)''',

contact)

self._db.commit()

def get_summary(self):

return self._db.cursor().execute(

"SELECT name, id from contacts").fetchall()

def get_contact(self, contact_id):

return self._db.cursor().execute(

"SELECT * from contacts where id=?", str(contact_id)).fetchone()

def get_current_contact(self):

if self.current_id is None:

return {"name": "", "address": "", "phone": "", "email": "", "notes": ""}

else:

return self.get_contact(self.current_id)

def update_current_contact(self, details):

if self.current_id is None:

self.add(details)

else:

self._db.cursor().execute('''

UPDATE contacts SET name=:name, phone=:phone, address=:address,

email=:email, notes=:notes WHERE id=:id''',

details)

self._db.commit()

def delete_contact(self, contact_id):

self._db.cursor().execute('''

DELETE FROM contacts WHERE id=:id''', {"id": contact_id})

self._db.commit()

ListViewクラス

code: asciimatics_views.py

class ListView(Frame):

def __init__(self, screen, model):

super(ListView, self).__init__(screen,

screen.height * 2 // 3,

screen.width * 2 // 3,

on_load=self._reload_list,

hover_focus=True,

title="Contact List")

# 連絡先データベースにアクセスするモデルを保存

self._model = model

# 連絡先のリストを表示するためのフォームを作成

self._list_view = ListBox(

Widget.FILL_FRAME,

model.get_summary(), name="contacts", on_select=self._on_pick)

self._edit_button = Button("Edit", self._edit)

self._delete_button = Button("Delete", self._delete)

self.add_layout(layout)

layout.add_widget(self._list_view)

layout.add_widget(Divider())

self.add_layout(layout2)

layout2.add_widget(Button("Add", self._add), 0)

layout2.add_widget(self._edit_button, 1)

layout2.add_widget(self._delete_button, 2)

layout2.add_widget(Button("Quit", self._quit), 3)

self.fix()

def _on_pick(self):

self._edit_button.disabled = self._list_view.value is None

self._delete_button.disabled = self._list_view.value is None

def _reload_list(self):

self._list_view.options = self._model.get_summary()

self._model.current_id = None

def _add(self):

self._model.current_id = None

raise NextScene("Edit Contact")

def _edit(self):

self.save()

raise NextScene("Edit Contact")

def _delete(self):

self.save()

self._reload_list()

@staticmethod

def _quit():

raise StopApplication("User pressed quit")

ContactViewクラス

注：ユーザーが連絡先を追加している場合は、まだ連絡先のデータがない場合があります

code: asciimatics_contactview.py

class ContactView(Frame):

def __init__(self, screen, model):

super(ContactView, self).__init__(screen,

screen.height * 2 // 3,

screen.width * 2 // 3,

hover_focus=True,

title="Contact Details")

# 連絡先データベースにアクセスするモデルを保存

self._model = model

# 連絡先のリストを表示するためのフォームを作成

self.add_layout(layout)

layout.add_widget(Text("Name:", "name"))

layout.add_widget(Text("Address:", "address"))

layout.add_widget(Text("Phone number:", "phone"))

layout.add_widget(Text("Email address:", "email"))

layout.add_widget(TextBox(5, "Notes:", "notes", as_string=True))

self.add_layout(layout2)

layout2.add_widget(Button("OK", self._ok), 0)

layout2.add_widget(Button("Cancel", self._cancel), 3)

self.fix()

def reset(self):

# 標準のリセットを実行してフォームをクリアしてから、新しいデータを入力

super(ContactView, self).reset()

self.data = self._model.get_current_contact()

def _ok(self):

self.save()

self._model.update_current_contact(self.data)

raise NextScene("Main")

@staticmethod

def _cancel():

raise NextScene("Main")

次に、ユーザーともう少しインタラクティブな処理をしたいと場合を想定しましょう。最初に決定する必要があるのは、ユーザからどのような情報を入手したいのか、そしてそれをどのように実現するかです。

入力できるようにするデータ：ユーザ名

それをどのようにフィールドに分解したいのか：名前と苗字

それらのフィールドをどう表現するのか：テキスト文字列

これらを設計できると、使用するウィジェットを決定できます。 標準的なものは次のとおりです。

table: ウィジェット

ウィジェットタイプ 説明

Button アクションボタン 例：OK/CANCEL など

CheckBox 単純な Yes/No のチェックボックス

DatePicker ポップアップリストを使用して日付選択の１行ウィジェット

Divider ウィジェット間のスペーサー

DropdownList ユーザーがひとつ値を選択できるリストをポップアップする１行ウィジェット

FileBrowser ローカルファイルシステムを一覧表示するための複数行ウィジェット

Label 関連するウィジェットグループのラベル

ListBox ユーザーが1つの値を選択できる可能なオプションのリスト

MultiColumnListBox ListBoxに似ているが、表形式のデータを表示するためのもの

RadioButtons ラジオボタンのリスト　ユーザーは候補リストから1つの値を選択する

Text 編集可能なテキストの1行

TextBox 編集可能なテキストの複数行

TimePicker ポップアップリストを使用して時間を選択するための１行ウィジェット

VerticalDivider 垂直線の仕切り　レイアウトの列の間に視覚的なマーカーを提供する

パスワードなどの機密データを非表示にすることができます。

次のコードは、80x20文字のフレームが作成され、それぞれが20列幅の4列が定義されます。

code: python

frame = Frame(screen, 80, 20, has_border=False)

frame.add_layout(layout)

レイアウトができたら、関連する列にウィジェットを追加できます。

次のコードは、最初と最後の列にボタンが追加されます。

code: python

ayout.add_widget(Button("OK", self._ok), 0)

layout.add_widget(Button("Cancel", self._cancel), 3)

すべての入力フィールドに標準のラベルを付けたい場合は、このままも構いません。 asciimaticsは、同じ列のすべてのフィールドでラベルの大きさを決定し、それらすべてをインデントして、より見た目に美しいレイアウトを作成します。

次のコードは、各フィールドのラベルが1つの列で提供され、すべてのフィールドが同じ深さまでインデントされます。

code: python

frame.add_layout(layout)

layout.add_widget(Text("Name:", "name"))

layout.add_widget(Text("Address:", "address"))

layout.add_widget(Text("Phone number:", "phone"))

layout.add_widget(Text("Email address:", "email"))

layout.add_widget(TextBox(5, "Notes:", "notes", as_string=True))

場合によっては、ウィジェットのさまざまなブロックに対して異なる配置が必要になることがあります。 このケースを処理するために、1つのフレームで複数のレイアウトを使用することができます。

次のコードは、フレームの上部でデータを入力でき、下部に結果のリストを入力できる検索ページとなります。

code: python

frame.add_layout(layout1)

layout1.add_widget(Text(label="Search:", name="search_string"))

frame.add_layout(layout2)

layout1.add_widget(TextBox(Widget.FILL_FRAME, name="results"))

ウィジェットの無効化

ただし、ウィジェットをプログラムで変更することは可能です。 たとえば、無効になっているウィジェットの値を変更することはできます。

レイアウトについての補足説明

より複雑な構成にする必要がある場合は、複数のレイアウトを使用できます。 Asciimaticsは、次のロジックを使用してウィジェットの場所を決定します。

フレームは1つ以上のレイアウトを所有しています。 レイアウトは、表示時に上下に重なります。つまり、フレームの最初のレイアウトが2番目のレイアウトの上にあります。

各レイアウトは、フレーム幅全体の比率として列を定義することにより、いくつかの水平方向の制約を定義します。

ウィジェットには、ウィジェットを所有するレイアウト内の列が割り当てられます。

次に、レイアウトは正確なサイズと場所を決定して、上記の制約に従って各ウィジェットが表示スペースに最適になるようにします。

code: display

+------------------------------------------------------------------------+

|Screen..................................................................|

|........................................................................|

|...+----------------------------------------------------------------+...|

|...|Frame |...|

|...|+--------------------------------------------------------------+|...|

|...||Layout 1 ||...|

|...|+--------------------------------------------------------------+|...|

|...|+------------------------------+-------------------------------+|...|

|...||Layout 2 | ||...|

|...|| - Column 1 | - Column 2 ||...|

|...|+------------------------------+-------------------------------+|...|

|...|+-------------+---------------------------------+--------------+|...|

|...||Layout 3 | < Widget 1 > | ||...|

|...|| | ... | ||...|

|...|| | < Widget N > | ||...|

|...|+-------------+---------------------------------+--------------+|...|

|...+----------------------------------------------------------------+...|

|........................................................................|

+------------------------------------------------------------------------+

これは、3つのレイアウトを持つ単一のフレームで構成されます。

1つ目は単一の全幅列

2つ目は2つの50％幅列

3つ目は相対サイズ25:50:25の3つの列

最後の列には、実際には2番目の列にいくつかのウィジェットが含まれています。

余白を埋める

複雑さを増すと、現在の画面のサイズに基づいて、フレームにさまざまなサイズを選択できます。画面のサイズが変更されるとフレームが再作成されるため、適切な場所に配置されます。

これは2つの方法で実現できます。

注意：

フレームを埋めるレイアウトやウィジェットは1つしか持てないことに注意してください。

複数設定しようとすると拒否されます。

フルスクリーンフレーム

大きなフレーム

フォームが非常に大きい場合は、大きすぎて標準の画面に収まらないことがあります。 これは問題ではありません。 ウィジェットをレイアウトに追加し続けることができ、asciimaticsはコンテンツを使用可能なスペースに自動的にクリップし、必要に応じてコンテンツをスクロールします。

カラースキーム

ウィジェットの色は、ウィジェットを含むフレームのパレットプロパティによって決定されます。 必要に応じて、フレームごとに異なるパレットを使用することもできますが、ユーザーはより統一性のあるUIを好む場合があります。

code: python

(Screen.COLOUR_GREEN, Screen.A_BOLD, Screen.COLOUR_BLUE)

次の表に、パレットに必要なキーを示します。

table: カラーパレット

Key 使用方法

“background” フレームの背景

“borders” フレーム枠とDividerウィジェット

“button” Buttonウィジェット

“control” CheckBoxウィジェットとRadiButtonsウィジェット

“disabled” すべての無効ウィジェット

“edit_text” TextウィジェットとTextBoxウィジェット

“field” Checkbox、RadioButtons、Listboxのオプションの値

“focus_button” 入力フォーカスがある Buttonウィジェット

“focus_control” 入力フォーカスがある Checkboxe、RadioButtonsウィジェット

“focus_edit_text” 入力フォーカスがあるText、TextBoxウィジェット

“focus_field” 入力フォーカスがあるフィールド

“invalid” 無効な値を含むウィジェット

“label” ウィジェットのラベル

“scroll” フレームのスクロールバー

“selected_control” Checkbox、 RadioButtons ウィジェットの選択中の項目

“selected_field” 選択中のフィールド

“selected_focus_control” 入力フォーカスがあるCheckbox、RadioButtons ウィジェットの選択中の項目

“selected_focus_field” 入力フォーカスがある選択中のフィールド

“title” フレームタイトル

table: テーマ

テーマ名 説明

“monochrome” シンプルな白黒の配色

“green” クラシカルなグリーンターミナル

“bright” 黒の背景、緑と黄色のスキーム

“tlj256” 黒、白、赤の影　256色表示可能な端末のみ

ウィジェットの色をカスタマイズ

インラインで色を変更

ウィジェット内の値を設定する

ここまでの情報で、基本的なユーザーインターフェースが稼働できるはずですが、フォームに既知の値を事前入力するために、各ウィジェットの値をどのように設定するかについて考えてみましょう。

これを処理する方法は2つあります。

ウィジェット内の値を取得する

いくつかのウィジェットを含むフレームがあり、ユーザーがそれらを入力しているとき、どのようにしてそれらが入力したものを見つけるのでしょうか？　このための2つの基本的な方法があります。

code: python

# Form definition

frame.add_layout(layout)

layout.add_widget(Text("Name:", "name"))

layout.add_widget(Text("Address:", "address"))

layout.add_widget(TextBox(5, "Notes:", "notes", as_string=True))

# ユーザーが入力した後のサンプルframe.data

{

"name": "Peter",

"address": "Somewhere on earth",

"notes": "Some multi-line\ntext from the user."

}

データの検証

入力フォーカス

カラーパレットの説明でも述べたように、asciimaticsには入力フォーカスの概念があります。 これは、キーボードからの入力を受け取るウィジェットです。 デフォルトのパレットを使用していると仮定すると、入力フォーカスのあるウィジェットが強調表示されます。 フォーカスは、カーソルキー、タブ/バックタブ、またはマウスを使用して移動することができます。

モーダルフレーム

これは通常、確認が必要なユーザーへの通知に使用されますが、これに限定されているわけではありません。

グローバルキー処理

code: python

# グローバルキーのイベントハンドラー

def global_shortcuts(event):

if isinstance(event, KeyboardEvent):

c = event.key_code

# ctrl+q か ctrl+x で終了

if c in (17, 24):

raise StopApplication("User terminated app")

# この設定をScreenオブジェクトに渡す

screen.play(scenes, unhandled_input=global_shortcuts)

注意：

グローバルハンドラーは、フォーカスがイベントを処理しない場合にのみ呼び出されます。

TextBoxウィジェットなどの一部のウィジェットはテキストを入力を取得するため、

このハンドラーに到達するキーは制御コードのみです。

フォーカスされているウィジェットのタイプや、フレームがモーダルであるかどうかによっては、

他のキーが到達することがあります。

デフォルトでは、フレームを含むシーンを再生している場合、グローバルハンドラーは何もしません。 それ以外の場合は、次のシーンにスキップする（スペースまたはEnter）、またはプログラムを終了する（QまたはX）ためのトップレベルロジックが含まれています。

Ctrl + CおよびCtrl + Zの処理

code: python

Screen.wrapper(demo, catch_interrupt=False)

Ctrl + Sの処理

制御の流れ

ここまでの説明で、いくつかのフレームを備えたプログラムが作成することができ、ユーザーがそれらのいずれかに入力したデータを抽出することができます。 しかし、ユーザがフレーム間を移動するかをどうやって知るのでしょうか？ その答えはコールバックと例外です。

コールバック

さらに、ウィジェットの値が変更されたときにトリガーできる他のイベントがあります。 これらは、別のウィジェットの現在の値に基づいてボタンを有効/無効にするなどの動的効果を提供するために使用できます。

例外

asciimaticsは例外を使用して、アニメーションエンジンに新しいシーンに移動するか、全体を停止するように指示します

処理する。 その他の例外はキャッチされないため、通常どおり使用できます。

新しい例外の詳細は次のとおりです。

このロジックでは、構築時にそれぞれシーンに一意の名前を付ける必要があることに注意してください。

code: python

# Sceneリスト...

scenes = [

]

screen.play(scenes)

# このコードを使用して、いつでも最初のシーンに戻ることができます...

raise NextScene("Main")

データ処理

ここまでの情報で、完全に機能するUIに必要なものがすべて揃っているはずです。ただし、asciimaticsにはデータを渡すためのクラスが用意されていないため、すべてのコンポーネントパーツにデータを渡す方法が明確ではありません。これは、特定の実装に縛られたくないという理由からです。

Model/Viewの設計より前の説明を振り返ってください。モデルは自由に好きなクラスに定義することができます

モデルクラスを定義して任意の状態を保存し、UI（別名ビュー）から必要に応じてそれにアクセスするための適切なAPIを提供します。

モデルへの保存された参照を使用して、ビューのコールバックまたはメソッド内で必要に応じて更新処理します。

動的なシーン

シーンを動的に変更したり、再構築する方法について説明しましょう。

まずは何を達成したいかを決める必要があります。 基本的な選択肢は次のとおりです。

同じ画面にいくつかの追加のフレームが必要な場合

例： ポップアップウィンドウ

既存のクラスを使用するだけです

既存のフレームの外に他のコンテンツを描画できるようにしたい場合

おそらく他のエフェクトを使用することをお勧めします。

フレーム内に何かを追加できるようにしたい場合

ほぼ確実に、その新しいコンテンツ用のカスタムウィジェットを作成する必要があります。

このセクションの残りの部分では、これらの方法についてもう少し詳しく説明します。

他の効果を追加

フレームは単なる別のエフェクトであるため、シーン内の他のエフェクトと組み合わせることができます。

次のコードは、アニメーション化されたジュリア集合のアニメーション効果の上に簡単な入力フォームが配置されます。

code: python

scenes = []

effects = [

Julia(screen),

InputFormFrame(screen)

]

scenes.append(Scene(effects, -1))

screen.play(scenes)

補足説明：

Zオーダーは、前面と背面と考える理解しやすいでしょう。

PopUpDialog

画面のサイズが変更されたときにオブジェクトを再構築する必要がある方法に制限があるため、これらは確認またはエラーの場合の単純なものに限定する必要があります。

例： ”XXXします！　本当によろしいですか？"

制限の詳細については、状態の復元に関するセクションを参照してください。

ポップアップメニュー

同様に、PopupMenuをシーンに追加することもできます。これらを使用すると、ユーザーが1つのエントリのみを選択する（クリックするか、フォーカスを移動してEnterキーを押す）か、リスト全体を閉じる（エスケープキーを押すか、メニューの外側をクリックする）必要がある単純な一時リストを作成できます。

それらは一時的なものであるため、画面のサイズ変更されると消失します。

画面のサイズ変更

ちょっとややこしく聞こえますね？ このことが、プレゼンテーションをアプリケーションロジックから分離することをお勧めする理由です。 それを正しく分離できると、実際には、最初にシーンを作成する前とまったく同じ初期化パスを通過することを意味することになります。

ただし、いくつかの落とし穴があります。

code: python

def main(screen, scene):

# Scene をここに定義

scenes = ...

# アプリケーションを実行

screen.play(scenes, stop_on_resize=True, start_scene=scene)

last_scene = None

while True:

try:

sys.exit(0)

except ResizeScreenError as e:

last_scene = e.scene

これで、画面のサイズが変更されたときに、すべてのUIがどのように表示されるかを決定できます。

サイズ変更時に再生していたシーンから再開します。

状態の復元

実行中のシーンのサイズが変更され、開始シーンとして画面に戻されると、新しいシーンはクローンメソッドでコピーされた古いすべてのエフェクトを実行します。見つかった場合は、2つのパラメーターを使用して呼び出します。クローンされた効果を持つ新しい画面と新しいシーンです。これにより、新しいエフェクトの再作成方法を完全に制御できます。 asciimaticsは、デフォルトで2つの方法でこのインターフェースを使用します。

新しいシーンでデータが確実に復元されるようにする

動的に追加されたPopUpDialogオブジェクトを新しいシーンにクローンする

この処理をオーバーライドして、独自のカスタムクローン作成ロジックを定義することもできます。 APIの正式な定義は次のように定義されています。

code: python

def clone(self, screen, scene):

"""

このエフェクトのクローンを新しい画面に作成する

:param screen: クローンを作成する新しいScreenオブジェクト

:param scene: クローンを作成する新しいSceneオブジェクト

"""

CPU使用率の削減

本格的なアニメーションシーンほど頻繁に更新する必要がないことは、テキストUIの性質です。したがって、asciimaticsは、フレームのみが画面に表示されている場合にリフレッシュレートを最適化します。

カスタムウィジェット

これらがすべて定義されると、このパッケージで提供される標準ウィジェットと同様に、新しいカスタムウィジェットをレイアウトに追加できるようになります。